-
Notifications
You must be signed in to change notification settings - Fork 222
Documentation revamp. #4129
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation revamp. #4129
Conversation
PR HealthChangelog Entry ✔️
Changes to files need to be accounted for in their respective changelogs. |
c4afc35
to
41930e4
Compare
41930e4
to
a6eeed2
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mentioning specific packages could seem like an endorsement and might not be what we want?
Maybe it would be better if we restrict it to packages we control and/or already endorse somehow?
Thanks! I added a column listing endorsements and a note that we don't endorse if not mentioned, how does that look to you please? |
This pages are gone due to dart-lang/build#4129
These pages are gone due to dart-lang/build#4129 Preview: https://dart-dev--pr6837-patch-1-8lua4imh.web.app/tools/build_runner --- - [x] I’ve reviewed the contributor guide and applied the relevant portions to this PR. - [x] This PR doesn't contain automatically generated corrections or text (Grammarly, LLMs, and similar). - [x] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style) — for example, it doesn't use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person). - [x] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer. <details> <summary>Contribution guidelines:</summary><br> - See our [contributor guide](https://github.com/dart-lang/site-www/blob/main/CONTRIBUTING.md) for general expectations for PRs. - Larger or significant changes should be discussed in an issue before creating a PR. - Code changes should generally follow the [Dart style guide](https://dart.dev/effective-dart) and use `dart format`. - Updates to [code excerpts](https://github.com/dart-lang/site-shared/blob/main/packages/excerpter) indicated by `<?code-excerpt` need to be updated in their source `.dart` file as well. </details> --------- Co-authored-by: Amanda Fitch <[email protected]>
These pages are gone due to dart-lang/build#4129 Preview: https://dart-dev--pr6837-patch-1-8lua4imh.web.app/tools/build_runner --- - [x] I’ve reviewed the contributor guide and applied the relevant portions to this PR. - [x] This PR doesn't contain automatically generated corrections or text (Grammarly, LLMs, and similar). - [x] This PR follows the [Google Developer Documentation Style Guidelines](https://developers.google.com/style) — for example, it doesn't use _i.e._ or _e.g._, and it avoids _I_ and _we_ (first person). - [x] This PR uses [semantic line breaks](https://github.com/dart-lang/site-shared/blob/main/doc/writing-for-dart-and-flutter-websites.md#semantic-line-breaks) of 80 characters or fewer. <details> <summary>Contribution guidelines:</summary><br> - See our [contributor guide](https://github.com/dart-lang/site-www/blob/main/CONTRIBUTING.md) for general expectations for PRs. - Larger or significant changes should be discussed in an issue before creating a PR. - Code changes should generally follow the [Dart style guide](https://dart.dev/effective-dart) and use `dart format`. - Updates to [code excerpts](https://github.com/dart-lang/site-shared/blob/main/packages/excerpter) indicated by `<?code-excerpt` need to be updated in their source `.dart` file as well. </details> --------- Co-authored-by: Amanda Fitch <[email protected]>
For #4119.
Full rewrite of the most obviously user-facing docs with a focus on how people mostly use build_runner today: build_runner, build, build_test. Added a list of popular builders based mostly on download stats from pub.dev.
Tweaks/cleanup but not a rewrite of docs that are not so user-facing: build_config, build_web_compilers.
Removed most other docs and FAQs, a lot of it is out of date and refers to niche uses of build_runner. Moved a few FAQ entries related to build_config into the build_config doc.